Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document option necessary to use biblatex. #470

Merged
merged 1 commit into from
Aug 31, 2024
Merged

Document option necessary to use biblatex. #470

merged 1 commit into from
Aug 31, 2024

Conversation

rdicosmo
Copy link
Contributor

Add explicit documentation about the need to pass natbib=false in the documentclass, and to remove any occurrence of \citestyle{authoryear} when using biblatex.

Fixes issue mentioned in PR #466

@rdicosmo
Document option necessary to use biblatex.
ce3752c 
Add explicit documentation about the need to pass natbib=false in the documentclass, and to remove any occurrence of \citestyle{authoryear} when using biblatex.
@rdicosmo rdicosmo mentioned this pull request Jun 16, 2022
Merged
@k4rtik
Copy link
Contributor

k4rtik commented Jun 24, 2022

Thanks @rdicosmo, I found another issue.

Apart from the changes you suggested in this PR, we should also ensure this warning is not shown while using BibLaTeX:

LaTeX Warning: Unused global option(s):
    [natbib=false].

@rdicosmo
Copy link
Contributor Author

Hi @k4rtik, AFAICT when you use biblatex properly there is no such warning.
See the output of this grep on the sample tex files:

$ grep natbib *-biblatex.log 
sample-acmsmall-biblatex.log:Package acmart Info: Explicitly selecting natbib mode on input line 135.
sample-acmsmall-biblatex.log:Package acmart Info: Explicitly deselecting natbib mode on input line 175.
sample-sigconf-biblatex.log:Package acmart Info: Explicitly selecting natbib mode on input line 135.
sample-sigconf-biblatex.log:Package acmart Info: Explicitly deselecting natbib mode on input line 175.

Apart from the changes you suggested in this PR, we should also ensure this warning is not shown while using BibLaTeX:

LaTeX Warning: Unused global option(s):
    [natbib=false].

@k4rtik
Copy link
Contributor

k4rtik commented Jul 6, 2022

@rdicosmo are you on the latest version of acmart from this repo?

I see the following:

❯ git describe
1.85-2-g9c7353b
❯ grep -B1 natbib *-biblatex.log
sample-acmsmall-biblatex.log-Package acmart Info: Not using nonacm mode on input line 120.
sample-acmsmall-biblatex.log:Package acmart Info: Explicitly selecting natbib mode on input line 136.
--
sample-acmsmall-biblatex.log-Package acmart Info: Not using authordraft mode on input line 162.
sample-acmsmall-biblatex.log:Package acmart Info: Explicitly deselecting natbib mode on input line 176.
--
sample-acmsmall-biblatex.log-LaTeX Warning: Unused global option(s):
sample-acmsmall-biblatex.log:    [natbib=false].
--
sample-sigconf-biblatex.log-Package acmart Info: Not using nonacm mode on input line 120.
sample-sigconf-biblatex.log:Package acmart Info: Explicitly selecting natbib mode on input line 136.
--
sample-sigconf-biblatex.log-Package acmart Info: Not using authordraft mode on input line 162.
sample-sigconf-biblatex.log:Package acmart Info: Explicitly deselecting natbib mode on input line 176.
--
sample-sigconf-biblatex.log-LaTeX Warning: Unused global option(s):
sample-sigconf-biblatex.log:    [natbib=false].

@rdicosmo
Copy link
Contributor Author

Hi @k4rtik , sorry for the late answer.
Here is what I see

$ git describe
v1.86
$ grep -H natbib *bibla*log
sample-acmsmall-biblatex.log:Package acmart Info: Explicitly selecting natbib mode on input line 136.
sample-acmsmall-biblatex.log:Package acmart Info: Explicitly deselecting natbib mode on input line 176.
sample-sigconf-biblatex.log:Package acmart Info: Explicitly selecting natbib mode on input line 136.
sample-sigconf-biblatex.log:Package acmart Info: Explicitly deselecting natbib mode on input line 176.

I also tested on 1.85-2-g9c7353b, with the same result.

My TeXlive version: 2020.20210202-3 on Debian bullseye

@rdicosmo
Copy link
Contributor Author

@borisveytsman may you merge this small documentation improvement?
It will really help users of biblatex.
Thanks!

P.S.: we'll keep looking at the issue @k4rtik mentioned, but it is not a blocker for this PR.

@k4rtik
Copy link
Contributor

k4rtik commented Jul 25, 2022

My TeXlive version: 2020.20210202-3 on Debian bullseye

It could be possibly this difference, I am generally on the latest TeXlive (2022).

@bennn
Copy link
Contributor

bennn commented Jul 7, 2023

ping @borisveytsman , this PR is critical to know how to use biblatex. Please merge!

@bennn
Copy link
Contributor

bennn commented Jul 29, 2023

reping @borisveytsman

@cabohah
Copy link

cabohah commented Jun 24, 2024

Thanks @rdicosmo, I found another issue.

Apart from the changes you suggested in this PR, we should also ensure this warning is not shown while using BibLaTeX:

LaTeX Warning: Unused global option(s):
    [natbib=false].

IMHO this is due to the issue I've reported as #533 and IMHO the main problem here is, that xkeyval ignores the changes in the option handling of LaTeX, e.g., the raw option list. But indeed the \DeclareOptionX{*} line in acmart should be changed too. See my report for more information.

@borisveytsman
Copy link
Owner

thanks

@borisveytsman borisveytsman merged commit 5e91749 into borisveytsman:primary Aug 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@rdicosmo @k4rtik @bennn @cabohah @borisveytsman